Fullscreen
![npm package](https://img.shields.io/npm/v/@pluginjs/fullscreen.svg)
fullscreen
is a utility JavaScript library for fullscreen.
Introduction
Installation
Yarn
yarn add @pluginjs/fullscreen
NPM
npm i @pluginjs/fullscreen
Getting Started
CDN:
Development:
<script src="https://unpkg.com/@pluginjs/fullscreen/dist/fullscreen.js"></script>
Production:
<script src="https://unpkg.com/@pluginjs/fullscreen/dist/fullscreen.min.js"></script>
API
request
Parameters
| Name | Type | Description |
|||-|
| args | Any[] | |
exit
Exit full screen.
toggle
Open full screen or exit full screen
isFullscreen
Returns
| Name | Type | Description |
|||-|
| isFullscreen | Boolean
| |
enabled
Returns
| Name | Type | Description |
|||-|
| isEnabled | Boolean
| |
element
Returns
| Name | Type | Description |
|||-|
| fullscreenElement | HTMLElement[]
| |
Browser support
Tested on all major browsers.
![IE / Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png) IE / Edge | ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) Firefox | ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) Chrome | ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png) Safari | ![Opera](https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png) Opera |
---|
IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
License
@pluginjs/fullscreen is Licensed under the GPL-v3 license.
If you want to use @pluginjs/fullscreen project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.
For purchase an Commercial License, contact us purchase@thecreation.co.
Copyright
Copyright (C) 2018 Creation Studio Limited.